Workbench Design/WB Collection.iso/workbench werkzeuge/bildschirmschoner/swazblanker/documentation/headlines

Amigaguide Document | 1996-04-07 | 5KB | 114 lines

@database "SwazBlanker/Headlines"
@master "Headlines.guide"
@author David Swasbrook
@(c) Copyright (C)1994 David Swasbrook. All Rights Reserved.
@$VER: Headlines.guide 1.1 (05.02.95)
@INDEX Index
@NODE MAIN "Headlines (05.02.95)"
    SWAZBLANKER : Headlines
    =======================
    (C) 1992-95 David Swasbrook,
         All Rights Reserved.
  @{" Introduction          " LINK Introduction        } What it actually does
  @{" Interface             " LINK Interface        } Configuration preferences
  @{" History               "    LINK History        } Bug fixes and updates
@ENDNODE
@NODE Introduction "What it actually does..."
    Headlines/Introduction
    ======================
  This blanker writes @{i}random @{ui}phrases to the display.
@ENDNODE
@NODE Interface "Configuration preferences..."
    Headlines/Interface
    ===================
@{b}           Save @{ub}- save and use the current settings.
@{b}            Use @{ub}- use the current settings.
@{b}           Test @{ub}- test the blanker under the current settings
@{b}         Cancel @{ub}- cancel all changes.
@{b}   Phrase Files @{ub}- this is a list showing the selected phrase files. You
                  may use the @{i}arrow keys @{ui}to move up/down the list, the
                  @{i}space key @{ui}may be used to toggle the checkbox. A tick
                  in the checkbox indicates that the phrase file can be
                  chosen as a data file for generating phrases.
                  Also you may double click or press @{i}return @{ui}to @{" edit " LINK Editor } the
                  currently hilighted data file.
                  @{i}Default: All available phrase files selected.@{ui}
@{b}    Phrase Path @{ub}- path to where the phrase files are located.
                  @{i}Default: Data/Headlines.@{ui}
@{b}           Font @{ub}- the font used to render the text.
                  @{i}Default: Helvetica 18 point.@{ui}
@{b}         Change @{ub}- this sets the number of phrases to be generated before
                  a new phrase file will be chosen. Setting this to @{i}Never@{ui}
                  means that the phrase file will remain the same during the
                  blank.
                  @{i}Default: 50.@{ui}
@{b}    Copper List @{ub}- if checked then a copper list will be used to change the
                  color of the text. This may not be available for some screen
                  modes and the gadget will be ghosted to indicate this. In the case
                  that the screen mode does not support copper lists or you do not
                  want to use a copper then the text will have the color cycled.
                  @{i}Default: Yes.@{ui}
@{b}   Display Mode @{ub}- the screen mode to use. If the preferred screen cannot
                  be opened then the default screen mode will be tried, if
                  this fails then the minimum screen mode required for this
                  blanker will be tried, if that fails then the blanker will
                  quit and let SwazBlanker choose an alternative blank
                  method.
                  @{i}Default: Hi-Resoloution Laced, 4 Colors.@{ui}
  If you wish to design your own phrase data files for Headlines please
  read @{" Data File Format " LINK DataFileFormat} for details.
@ENDNODE
@NODE Editor "Editor..."
    Headlines/Editor
    ================
    The textfield.gadget is Copyright
1994 Mark Thomas ([e-mail]).
@ENDNODE
@NODE DataFileFormat "Data file format..."
    Headlines/DataFileFormat
    ========================
    The data file for quotes is a text file of the following format:
        ---- start of file ----
        \\* PHRASE FILE
        \\* Breif description
        \\*
        %<CLASS 1>
        Class1 String 1
        Class1 String 2
        Class1 String 3
        %<CLASS 2>
        Class2 String 1
        Class2 String 2
        Class2 String 3
        %<CLASS 3>
        %MAIN
        Main String 1
        Main String 2
        ---- end of file ----
    "%%"      - file terminator
    "%<CLASS> - defines a new class, this is followed by a series of
                strings that make up that class, they may reference
                other classes by using \CLASS. When \CLASS is found
                a random string from that class is chosen and will
                evaluated.
    "%MAIN"   - defines the main class strings. These are used as the
                base to generate the phrases. See %<CLASS> for further
                details.
@ENDNODE
@NODE History "Bug fixes and updates..."
    Headlines/History
    =================
`1.1'    o Was locking when building the text to render onto the display.
`1.0'    o When a certain number of phrases have been generated a new data
      file may be chosen.
@ENDNODE
@NODE Index
    Headlines/Index
    ===============
  @{" Data File Format      " LINK DataFileFormat           } Format of the headlines data files
  @{" Editor                " LINK Editor        } Edit the phrase files
  @{" History               "    LINK History        } Bug fixes and updates
  @{" Interface             " LINK Interface        } Configuration preferences
  @{" Introduction          " LINK Introduction        } What it actually does
@ENDNODE